Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add LocalTmpStorage for all services #17588

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

rohangarg
Copy link
Member

Provides an interface for getting local temporary storage in all the services. In all future changes, the users can directly inject an object of LocalTmpStorage and use the temporary directory in it as a scratch pad.
Along with the consolidation and possible ability to track all temp data in future, this also provides a common interface for interacting with all local temporary storage work.

Copy link
Contributor

@imply-cheddar imply-cheddar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs tests for coverage. Add those before merging please.

@LazySingleton
public LocalTmpStorage getLocalTmpStorage()
{
File tmpDir = new File(taskDirPath, "tmp");
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cheddar : should we create the temporary storage per attempt? or should we share it across attempts for re-use of temp data?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's share it. The old default for cases where this would've been used is just java.io.tmpdir which was shared as well, so it shouldn't cause problems...


import java.io.File;

public interface LocalTmpStorage
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pretty similar to TempDirProducer ; to service this usecase maybe that could be enhanced with a lazy init and a getRoot ?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TempDirProducer appears to have semantics around cleaning up with close(). That class is different from this class, this class is basically just a Config. It could be called a Config, but Rohan doesn't like the word config, so it got this name instead.

LocalTmpStorage is just delivering a location, nothing more, nothing less, it provides something that can be injected to get at a system-configured tmp storage location and is not intended to actually do anything beyond that. It probably deserves javadoc that describes that this class shouldn't be doing anything other than delivering configuration as it's just there to be an injectable configuration object.

It could absolutely make sense to have TempDirProducer depend on a LocalTmpStorage in order to get the tmp dir location that it's supposed to use.

*/
File getTmpDir();

class DefaultLocalTmpStorageProvider implements Provider<LocalTmpStorage>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

doesn't seem like the system will prepare to clean up these files - wouldn't that will fill up the disk/create garabge?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The tmpdir provided from this is just a location. Whether things are cleaned up or not is a question of the implementation. In general, most of the code that deals with tmp files cleans them up after itself and if it's not cleaning up after itself, that should either be intentional and have a design reason or it is a bug in the code that's dealing with the file, not a bug in the code that's delivering the location of the directory.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants